<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Open SCA: AggregateDevice_impl Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.onetek.net"><img alt="Logo" src="openscaLogo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Open SCA
   &#160;<span id="projectnumber">Version 0.6.0</span>
   </div>
   <div id="projectbrief">Open SCA</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_aggregate_device__impl.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="class_aggregate_device__impl-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">AggregateDevice_impl Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_aggregate_device__impl_8h_source.html">AggregateDevice_impl.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for AggregateDevice_impl:</div>
<div class="dyncontent">
<div class="center"><img src="class_aggregate_device__impl__inherit__graph.png" border="0" usemap="#_aggregate_device__impl_inherit__map" alt="Inheritance graph"/></div>
<map name="_aggregate_device__impl_inherit__map" id="_aggregate_device__impl_inherit__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a67bbab699e62f84e5a9e9b6b60e65cd7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_aggregate_device__impl.html#a67bbab699e62f84e5a9e9b6b60e65cd7">AggregateDevice_impl</a> ()</td></tr>
<tr class="separator:a67bbab699e62f84e5a9e9b6b60e65cd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14b47c5f0770305d4ffc2a29ae6108f7"><td class="memItemLeft" align="right" valign="top">CF::DeviceSequence *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_aggregate_device__impl.html#a14b47c5f0770305d4ffc2a29ae6108f7">devices</a> ()</td></tr>
<tr class="memdesc:a14b47c5f0770305d4ffc2a29ae6108f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a list of devices added to this device.  <a href="#a14b47c5f0770305d4ffc2a29ae6108f7">More...</a><br /></td></tr>
<tr class="separator:a14b47c5f0770305d4ffc2a29ae6108f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96884ccd35f35c79466213c5ee83722c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_aggregate_device__impl.html#a96884ccd35f35c79466213c5ee83722c">addDevice</a> (CF::Device_ptr associatedDevice)  throw (CF::InvalidObjectReference)</td></tr>
<tr class="memdesc:a96884ccd35f35c79466213c5ee83722c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The addDevice operation shall add the input associatedDevice parameter to the AggregateDevice’s devices attribute when the associatedDevice does not exist in the devices attribute.  <a href="#a96884ccd35f35c79466213c5ee83722c">More...</a><br /></td></tr>
<tr class="separator:a96884ccd35f35c79466213c5ee83722c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82c05c720bf4bbaae8457ae37552b022"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_aggregate_device__impl.html#a82c05c720bf4bbaae8457ae37552b022">removeDevice</a> (CF::Device_ptr associatedDevice)  throw (CF::InvalidObjectReference)</td></tr>
<tr class="memdesc:a82c05c720bf4bbaae8457ae37552b022"><td class="mdescLeft">&#160;</td><td class="mdescRight">The removeDevice operation shall remove the input associatedDevice parameter from the AggregateDevice’s devices attribute.  <a href="#a82c05c720bf4bbaae8457ae37552b022">More...</a><br /></td></tr>
<tr class="separator:a82c05c720bf4bbaae8457ae37552b022"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dc50923715330ee5bfd568e64c31788"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_aggregate_device__impl.html#a6dc50923715330ee5bfd568e64c31788">devExists</a> (const CF::Device_ptr device, CORBA::ULong &amp;index)</td></tr>
<tr class="memdesc:a6dc50923715330ee5bfd568e64c31788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check existion of the specific device.  <a href="#a6dc50923715330ee5bfd568e64c31788">More...</a><br /></td></tr>
<tr class="separator:a6dc50923715330ee5bfd568e64c31788"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aef373d9941e7172986909c31a51e0dde"><td class="memItemLeft" align="right" valign="top">CF::DeviceSequence&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_aggregate_device__impl.html#aef373d9941e7172986909c31a51e0dde">m_subDevices</a></td></tr>
<tr class="memdesc:aef373d9941e7172986909c31a51e0dde"><td class="mdescLeft">&#160;</td><td class="mdescRight">The readonly devices attribute shall contain a list of devices that have been added to this device or a sequence length of zero if the device has no aggregation relationships with other devices.  <a href="#aef373d9941e7172986909c31a51e0dde">More...</a><br /></td></tr>
<tr class="separator:aef373d9941e7172986909c31a51e0dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="_aggregate_device__impl_8h_source.html#l00028">28</a> of file <a class="el" href="_aggregate_device__impl_8h_source.html">AggregateDevice_impl.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a67bbab699e62f84e5a9e9b6b60e65cd7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_aggregate_device__impl.html">AggregateDevice_impl</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_aggregate_device__impl_8cpp_source.html#l00024">24</a> of file <a class="el" href="_aggregate_device__impl_8cpp_source.html">AggregateDevice_impl.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a96884ccd35f35c79466213c5ee83722c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void addDevice </td>
          <td>(</td>
          <td class="paramtype">CF::Device_ptr&#160;</td>
          <td class="paramname"><em>associatedDevice</em></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">CF::InvalidObjectReference</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The addDevice operation shall add the input associatedDevice parameter to the AggregateDevice’s devices attribute when the associatedDevice does not exist in the devices attribute. </p>
<p>The associatedDevice is ignored when duplicated. The addDevice operation shall write a FAILURE_ALARM log record, upon unsuccessful adding of an associatedDevice to the AggregateDevice’s devices attribute.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">associatedDevice</td><td>device need to be added. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_aggregate_device__impl_8cpp_source.html#l00090">90</a> of file <a class="el" href="_aggregate_device__impl_8cpp_source.html">AggregateDevice_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a6dc50923715330ee5bfd568e64c31788"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool devExists </td>
          <td>(</td>
          <td class="paramtype">const CF::Device_ptr&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">CORBA::ULong &amp;&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check existion of the specific device. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>device which needs to be checked. </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">index</td><td>index of the device at m_subDevices.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>existion of the specific device. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>the device is existent. </td></tr>
    <tr><td class="paramname">false</td><td>the device is nonexistent. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_aggregate_device__impl_8cpp_source.html#l00061">61</a> of file <a class="el" href="_aggregate_device__impl_8cpp_source.html">AggregateDevice_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a14b47c5f0770305d4ffc2a29ae6108f7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CF::DeviceSequence * devices </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get a list of devices added to this device. </p>
<dl class="section return"><dt>Returns</dt><dd>a list of devices added to this device. </dd></dl>

<p>Definition at line <a class="el" href="_aggregate_device__impl_8cpp_source.html#l00036">36</a> of file <a class="el" href="_aggregate_device__impl_8cpp_source.html">AggregateDevice_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a82c05c720bf4bbaae8457ae37552b022"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void removeDevice </td>
          <td>(</td>
          <td class="paramtype">CF::Device_ptr&#160;</td>
          <td class="paramname"><em>associatedDevice</em></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">CF::InvalidObjectReference</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The removeDevice operation shall remove the input associatedDevice parameter from the AggregateDevice’s devices attribute. </p>
<p>The removeDevice operation shall write a FAILURE_ALARM log record, upon unsuccessful removal of the associatedDevice from the AggregateDevice devices attribute.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">associatedDevice</td><td>device need to be removed. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_aggregate_device__impl_8cpp_source.html#l00120">120</a> of file <a class="el" href="_aggregate_device__impl_8cpp_source.html">AggregateDevice_impl.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aef373d9941e7172986909c31a51e0dde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CF::DeviceSequence m_subDevices</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The readonly devices attribute shall contain a list of devices that have been added to this device or a sequence length of zero if the device has no aggregation relationships with other devices. </p>

<p>Definition at line <a class="el" href="_aggregate_device__impl_8h_source.html#l00090">90</a> of file <a class="el" href="_aggregate_device__impl_8h_source.html">AggregateDevice_impl.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>frameworks/libCF_Utils/include/<a class="el" href="_aggregate_device__impl_8h_source.html">AggregateDevice_impl.h</a></li>
<li>frameworks/libCF_Utils/src/<a class="el" href="_aggregate_device__impl_8cpp_source.html">AggregateDevice_impl.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_aggregate_device__impl.html">AggregateDevice_impl</a></li>
    <li class="footer">Generated on Fri Jul 12 2019 14:31:54 for
    <a href="http://www.onetek.net">
    <img class="footer" src="openscaLogo.png" height="31" alt="openSCA"/></a>
    </li>
  </ul>
</div>
</body>
</html>
